Skip to main content
POST
Handles `POST /v1/webhooks/endpoints`.

Authorizations

Authorization
string
header
required

A tenant API key. Acts for exactly one tenant and cannot conclude a case, because a conclusion records a person.

Body

application/json

Endpoint registration request body.

secret
string
required

Shared secret used to sign payloads.

url
string
required

Destination URL.

event_types
string[]

Event names wanted. Empty or absent means every event.

Response

The endpoint, with its signing secret

An endpoint as returned to a customer, without its secret.

active
boolean
required

Whether deliveries are attempted.

created_at
string
required

RFC 3339 creation timestamp.

endpoint_id
string
required

Endpoint identifier.

event_types
string[]
required

Event names wanted; empty means every event.

url
string
required

Destination URL.